org.springframework.messaging.handler.invocation

Class InvocableHandlerMethod

java.lang.Object

org.springframework.messaging.handler.HandlerMethod

org.springframework.messaging.handler.invocation.InvocableHandlerMethod

public class InvocableHandlerMethod
extends HandlerMethod

Invokes the handler method for a given message after resolving its method argument values through registered HandlerMethodArgumentResolvers.

Use setMessageMethodArgumentResolvers(HandlerMethodArgumentResolver) to customize the list of argument resolvers.

Since:

4.0

Author:

Rossen Stoyanchev, Juergen Hoeller

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private class	InvocableHandlerMethod.AsyncResultMethodParameter

Nested classes/interfaces inherited from class org.springframework.messaging.handler.HandlerMethod

HandlerMethod.HandlerMethodParameter

Field Summary

Fields

Modifier and Type	Field and Description
private HandlerMethodArgumentResolver	argumentResolvers
private ParameterNameDiscoverer	parameterNameDiscoverer

Fields inherited from class org.springframework.messaging.handler.HandlerMethod

logger

Constructor Summary

Constructors

Constructor and Description
InvocableHandlerMethod(HandlerMethod handlerMethod) Create an instance from a HandlerMethod.
InvocableHandlerMethod(java.lang.Object bean, java.lang.reflect.Method method) Create an instance from a bean instance and a method.
InvocableHandlerMethod(java.lang.Object bean, java.lang.String methodName, java.lang.Class<?>... parameterTypes) Construct a new handler method with the given bean instance, method name and parameters.

Method Summary

Modifier and Type	Method and Description
private void	assertTargetBean(java.lang.reflect.Method method, java.lang.Object targetBean, java.lang.Object[] args) Assert that the target bean class is an instance of the class where the given method is declared.
protected java.lang.Object	doInvoke(java.lang.Object... args) Invoke the handler method with the given argument values.
private java.lang.String	getArgumentResolutionErrorMessage(java.lang.String message, int index)
(package private) MethodParameter	getAsyncReturnValueType(java.lang.Object returnValue)
protected java.lang.String	getDetailedErrorMessage(java.lang.String message) Adds HandlerMethod details such as the controller type and method signature to the given error message.
private java.lang.String	getInvocationErrorMessage(java.lang.String message, java.lang.Object[] resolvedArgs)
private java.lang.Object[]	getMethodArgumentValues(Message<?> message, java.lang.Object... providedArgs) Get the method argument values for the current request.
java.lang.Object	invoke(Message<?> message, java.lang.Object... providedArgs) Invoke the method with the given message.
private java.lang.Object	resolveProvidedArgument(MethodParameter parameter, java.lang.Object... providedArgs) Attempt to resolve a method parameter from the list of provided argument values.
void	setMessageMethodArgumentResolvers(HandlerMethodArgumentResolver argumentResolvers) Set HandlerMethodArgumentResolvers to use to use for resolving method argument values.
void	setParameterNameDiscoverer(ParameterNameDiscoverer parameterNameDiscoverer) Set the ParameterNameDiscoverer for resolving parameter names when needed (e.g.

Methods inherited from class org.springframework.messaging.handler.HandlerMethod

createWithResolvedBean, equals, getBean, getBeanType, getBridgedMethod, getMethod, getMethodAnnotation, getMethodParameters, getReturnType, getReturnValueType, getShortLogMessage, hashCode, isVoid, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

argumentResolvers

private HandlerMethodArgumentResolver argumentResolvers

parameterNameDiscoverer

private ParameterNameDiscoverer parameterNameDiscoverer

Constructor Detail

InvocableHandlerMethod

public InvocableHandlerMethod(HandlerMethod handlerMethod)

Create an instance from a HandlerMethod.

InvocableHandlerMethod

public InvocableHandlerMethod(java.lang.Object bean,
                              java.lang.reflect.Method method)

Create an instance from a bean instance and a method.

InvocableHandlerMethod

public InvocableHandlerMethod(java.lang.Object bean,
                              java.lang.String methodName,
                              java.lang.Class<?>... parameterTypes)
                       throws java.lang.NoSuchMethodException

Construct a new handler method with the given bean instance, method name and parameters.

Parameters:

bean - the object bean

methodName - the method name

parameterTypes - the method parameter types

Throws:

java.lang.NoSuchMethodException - when the method cannot be found

Method Detail

setMessageMethodArgumentResolvers

public void setMessageMethodArgumentResolvers(HandlerMethodArgumentResolver argumentResolvers)

Set HandlerMethodArgumentResolvers to use to use for resolving method argument values.

setParameterNameDiscoverer

public void setParameterNameDiscoverer(ParameterNameDiscoverer parameterNameDiscoverer)

Set the ParameterNameDiscoverer for resolving parameter names when needed (e.g. default request attribute name).

Default is a DefaultParameterNameDiscoverer.

invoke

public java.lang.Object invoke(Message<?> message,
                               java.lang.Object... providedArgs)
                        throws java.lang.Exception

Invoke the method with the given message.

Throws:

java.lang.Exception - raised if no suitable argument resolver can be found, or the method raised an exception

getMethodArgumentValues

private java.lang.Object[] getMethodArgumentValues(Message<?> message,
                                                   java.lang.Object... providedArgs)
                                            throws java.lang.Exception

Get the method argument values for the current request.

Throws:

java.lang.Exception

getArgumentResolutionErrorMessage

private java.lang.String getArgumentResolutionErrorMessage(java.lang.String message,
                                                           int index)

getDetailedErrorMessage

protected java.lang.String getDetailedErrorMessage(java.lang.String message)

Adds HandlerMethod details such as the controller type and method signature to the given error message.

Parameters:

message - error message to append the HandlerMethod details to

resolveProvidedArgument

private java.lang.Object resolveProvidedArgument(MethodParameter parameter,
                                                 java.lang.Object... providedArgs)

Attempt to resolve a method parameter from the list of provided argument values.

doInvoke

protected java.lang.Object doInvoke(java.lang.Object... args)
                             throws java.lang.Exception

Invoke the handler method with the given argument values.

Throws:

java.lang.Exception

assertTargetBean

private void assertTargetBean(java.lang.reflect.Method method,
                              java.lang.Object targetBean,
                              java.lang.Object[] args)

Assert that the target bean class is an instance of the class where the given method is declared. In some cases the actual controller instance at request- processing time may be a JDK dynamic proxy (lazy initialization, prototype beans, and others). @Controller's that require proxying should prefer class-based proxy mechanisms.

getInvocationErrorMessage

private java.lang.String getInvocationErrorMessage(java.lang.String message,
                                                   java.lang.Object[] resolvedArgs)

getAsyncReturnValueType

MethodParameter getAsyncReturnValueType(java.lang.Object returnValue)